From 17c26dbbc18e245ccaf16bdc7e3ab7bcaab3c339 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Mon, 11 Oct 2004 05:38:47 +0000 Subject: [PATCH] Document GtkTreeIterCompareFunc (#154943) 2004-10-11 Matthias Clasen * gtk/tmpl/gtktreesortable.sgml: Document GtkTreeIterCompareFunc (#154943) --- docs/reference/ChangeLog | 5 +++++ docs/reference/gtk/tmpl/gtktreesortable.sgml | 23 ++++++++++++++------ 2 files changed, 21 insertions(+), 7 deletions(-) diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 0b88c26796..a5a053cfee 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,8 @@ +2004-10-11 Matthias Clasen + + * gtk/tmpl/gtktreesortable.sgml: Document GtkTreeIterCompareFunc + (#154943) + 2004-10-10 Matthias Clasen * gtk/images/progressbar.png: diff --git a/docs/reference/gtk/tmpl/gtktreesortable.sgml b/docs/reference/gtk/tmpl/gtktreesortable.sgml index f58e9e6ab1..ee721423b5 100644 --- a/docs/reference/gtk/tmpl/gtktreesortable.sgml +++ b/docs/reference/gtk/tmpl/gtktreesortable.sgml @@ -42,15 +42,24 @@ The interface for sortable models used by GtkTreeView - +A GtkTreeIterCompareFunc should return a negative integer, zero, or a positive +integer if @a sorts before @b, @a sorts with @b, or @a sorts after @b +respectively. If two iters compare as equal, their order in the sorted model +is undefined. In order to ensure that the #GtkTreeSortable behaves as +expected, the GtkTreeIterCompareFunc must define a partial order on +the model, i.e. it must be reflexive, antisymmetric and transitive. + + +For example, if @model is a product catalogue, then a compare function +for the "price" column could be one which returns +price_of(@a) - price_of(@b). -@model: -@a: -@b: -@user_data: -@Returns: - +@model: The #GtkTreeModel the comparison is within +@a: A #GtkTreeIter in @model +@b: Another #GtkTreeIter in @model +@user_data: Data passed when the compare func is assigned e.g. by +gtk_tree_sortable_set_sort_func() -- 2.30.2